<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>XMLLayoutTest xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> * the License.  You may obtain a copy of the License at</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> *</em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> *</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> * limitations under the License.</em>
<a name="16" href="#16">16</a>  <em class="jxr_comment"> */</em>
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">package</strong> org.apache.log4j.xml;
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> org.apache.log4j.Layout;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> org.apache.log4j.LayoutTest;
<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> org.apache.log4j.Level;
<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> org.apache.log4j.Logger;
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.apache.log4j.NDC;
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> org.apache.log4j.MDC;
<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> org.apache.log4j.spi.LoggingEvent;
<a name="27" href="#27">27</a>  
<a name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> org.w3c.dom.Document;
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> org.w3c.dom.Element;
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> org.w3c.dom.Node;
<a name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> org.w3c.dom.NodeList;
<a name="32" href="#32">32</a>  
<a name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> org.xml.sax.InputSource;
<a name="34" href="#34">34</a>  
<a name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> java.io.Reader;
<a name="36" href="#36">36</a>  <strong class="jxr_keyword">import</strong> java.io.StringReader;
<a name="37" href="#37">37</a>  <strong class="jxr_keyword">import</strong> java.util.Hashtable;
<a name="38" href="#38">38</a>  
<a name="39" href="#39">39</a>  <strong class="jxr_keyword">import</strong> javax.xml.parsers.DocumentBuilder;
<a name="40" href="#40">40</a>  <strong class="jxr_keyword">import</strong> javax.xml.parsers.DocumentBuilderFactory;
<a name="41" href="#41">41</a>  
<a name="42" href="#42">42</a>  
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment">/**</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * Test for XMLLayout.</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> *</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> * @author Curt Arnold</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> */</em>
<a name="48" href="#48">48</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/log4j/xml/XMLLayoutTest.html">XMLLayoutTest</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/log4j/LayoutTest.html">LayoutTest</a> {
<a name="49" href="#49">49</a>    <em class="jxr_javadoccomment">/**</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">   * Construct new instance of XMLLayoutTest.</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment">   *</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment">   * @param testName test name.</em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment">   */</em>
<a name="54" href="#54">54</a>    <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/log4j/xml/XMLLayoutTest.html">XMLLayoutTest</a>(<strong class="jxr_keyword">final</strong> String testName) {
<a name="55" href="#55">55</a>      <strong class="jxr_keyword">super</strong>(testName, <span class="jxr_string">"text/plain"</span>, false, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>);
<a name="56" href="#56">56</a>    }
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>      <em class="jxr_javadoccomment">/**</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment">     * Clear MDC and NDC before test.</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">     */</em>
<a name="61" href="#61">61</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUp() {
<a name="62" href="#62">62</a>        NDC.clear();
<a name="63" href="#63">63</a>        <strong class="jxr_keyword">if</strong> (MDC.getContext() != <strong class="jxr_keyword">null</strong>) {
<a name="64" href="#64">64</a>          MDC.getContext().clear();
<a name="65" href="#65">65</a>        }
<a name="66" href="#66">66</a>    }
<a name="67" href="#67">67</a>  
<a name="68" href="#68">68</a>      <em class="jxr_javadoccomment">/**</em>
<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">     * Clear MDC and NDC after test.</em>
<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">     */</em>
<a name="71" href="#71">71</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> tearDown() {
<a name="72" href="#72">72</a>        setUp();
<a name="73" href="#73">73</a>    }
<a name="74" href="#74">74</a>  
<a name="75" href="#75">75</a>    <em class="jxr_javadoccomment">/**</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">   * @{inheritDoc}</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">   */</em>
<a name="78" href="#78">78</a>    <strong class="jxr_keyword">protected</strong> Layout createLayout() {
<a name="79" href="#79">79</a>      <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> XMLLayout();
<a name="80" href="#80">80</a>    }
<a name="81" href="#81">81</a>  
<a name="82" href="#82">82</a>    <em class="jxr_javadoccomment">/**</em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">   * Parses the string as the body of an XML document and returns the document element.</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">   * @param source source string.</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">   * @return document element.</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">   * @throws Exception if parser can not be constructed or source is not a valid XML document.</em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">   */</em>
<a name="88" href="#88">88</a>    <strong class="jxr_keyword">private</strong> Element parse(<strong class="jxr_keyword">final</strong> String source) <strong class="jxr_keyword">throws</strong> Exception {
<a name="89" href="#89">89</a>      DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
<a name="90" href="#90">90</a>      factory.setNamespaceAware(false);
<a name="91" href="#91">91</a>      factory.setCoalescing(<strong class="jxr_keyword">true</strong>);
<a name="92" href="#92">92</a>  
<a name="93" href="#93">93</a>      DocumentBuilder builder = factory.newDocumentBuilder();
<a name="94" href="#94">94</a>      Reader reader = <strong class="jxr_keyword">new</strong> StringReader(source);
<a name="95" href="#95">95</a>      Document doc = builder.parse(<strong class="jxr_keyword">new</strong> InputSource(reader));
<a name="96" href="#96">96</a>  
<a name="97" href="#97">97</a>      <strong class="jxr_keyword">return</strong> doc.getDocumentElement();
<a name="98" href="#98">98</a>    }
<a name="99" href="#99">99</a>  
<a name="100" href="#100">100</a>   <em class="jxr_javadoccomment">/**</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">   * Checks a log4j:event element against expectations.</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">   * @param element element, may not be null.</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">   * @param event event, may not be null.</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">   */</em>
<a name="105" href="#105">105</a>   <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkEventElement(
<a name="106" href="#106">106</a>     <strong class="jxr_keyword">final</strong> Element element, <strong class="jxr_keyword">final</strong> LoggingEvent event) {
<a name="107" href="#107">107</a>     assertEquals(<span class="jxr_string">"log4j:event"</span>, element.getTagName());
<a name="108" href="#108">108</a>     assertEquals(
<a name="109" href="#109">109</a>       event.getLoggerName(), element.getAttribute(<span class="jxr_string">"logger"</span>));
<a name="110" href="#110">110</a>     assertEquals(
<a name="111" href="#111">111</a>       Long.toString(event.timeStamp), element.getAttribute(<span class="jxr_string">"timestamp"</span>));
<a name="112" href="#112">112</a>     assertEquals(event.getLevel().toString(), element.getAttribute(<span class="jxr_string">"level"</span>));
<a name="113" href="#113">113</a>     assertEquals(event.getThreadName(), element.getAttribute(<span class="jxr_string">"thread"</span>));
<a name="114" href="#114">114</a>   }
<a name="115" href="#115">115</a> 
<a name="116" href="#116">116</a>   <em class="jxr_javadoccomment">/**</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">   * Checks a log4j:message element against expectations.</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">   * @param element element, may not be null.</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">   * @param message expected message.</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">   */</em>
<a name="121" href="#121">121</a>   <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkMessageElement(
<a name="122" href="#122">122</a>     <strong class="jxr_keyword">final</strong> Element element, <strong class="jxr_keyword">final</strong> String message) {
<a name="123" href="#123">123</a>     assertEquals(<span class="jxr_string">"log4j:message"</span>, element.getTagName());
<a name="124" href="#124">124</a> 
<a name="125" href="#125">125</a>     Node messageNode = element.getFirstChild();
<a name="126" href="#126">126</a>     assertNotNull(messageNode);
<a name="127" href="#127">127</a>     assertEquals(Node.TEXT_NODE, messageNode.getNodeType());
<a name="128" href="#128">128</a>     assertEquals(message, messageNode.getNodeValue());
<a name="129" href="#129">129</a>     assertNull(messageNode.getNextSibling());
<a name="130" href="#130">130</a>   }
<a name="131" href="#131">131</a> 
<a name="132" href="#132">132</a>   <em class="jxr_javadoccomment">/**</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">   * Checks a log4j:message element against expectations.</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">   * @param element element, may not be null.</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">   * @param message expected message.</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">   */</em>
<a name="137" href="#137">137</a>   <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkNDCElement(<strong class="jxr_keyword">final</strong> Element element, <strong class="jxr_keyword">final</strong> String message) {
<a name="138" href="#138">138</a>     assertEquals(<span class="jxr_string">"log4j:NDC"</span>, element.getTagName());
<a name="139" href="#139">139</a> 
<a name="140" href="#140">140</a>     Node messageNode = element.getFirstChild();
<a name="141" href="#141">141</a>     assertNotNull(messageNode);
<a name="142" href="#142">142</a>     assertEquals(Node.TEXT_NODE, messageNode.getNodeType());
<a name="143" href="#143">143</a>     assertEquals(message, messageNode.getNodeValue());
<a name="144" href="#144">144</a>     assertNull(messageNode.getNextSibling());
<a name="145" href="#145">145</a>   }
<a name="146" href="#146">146</a> 
<a name="147" href="#147">147</a>   <em class="jxr_javadoccomment">/**</em>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment">   * Checks a log4j:throwable element against expectations.</em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment">   * @param element element, may not be null.</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment">   * @param ex exception, may not be null.</em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">   */</em>
<a name="152" href="#152">152</a>   <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkThrowableElement(
<a name="153" href="#153">153</a>     <strong class="jxr_keyword">final</strong> Element element, <strong class="jxr_keyword">final</strong> Exception ex) {
<a name="154" href="#154">154</a>     assertEquals(<span class="jxr_string">"log4j:throwable"</span>, element.getTagName());
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>     Node messageNode = element.getFirstChild();
<a name="157" href="#157">157</a>     assertNotNull(messageNode);
<a name="158" href="#158">158</a>     assertEquals(Node.TEXT_NODE, messageNode.getNodeType());
<a name="159" href="#159">159</a> 
<a name="160" href="#160">160</a>     String msg = ex.toString();
<a name="161" href="#161">161</a>     assertEquals(msg, messageNode.getNodeValue().substring(0, msg.length()));
<a name="162" href="#162">162</a>     assertNull(messageNode.getNextSibling());
<a name="163" href="#163">163</a>   }
<a name="164" href="#164">164</a> 
<a name="165" href="#165">165</a>     <em class="jxr_javadoccomment">/**</em>
<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">     * Checks a log4j:properties element against expectations.</em>
<a name="167" href="#167">167</a> <em class="jxr_javadoccomment">     * @param element element, may not be null.</em>
<a name="168" href="#168">168</a> <em class="jxr_javadoccomment">     * @param key key.</em>
<a name="169" href="#169">169</a> <em class="jxr_javadoccomment">     * @param value value.</em>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">     */</em>
<a name="171" href="#171">171</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkPropertiesElement(
<a name="172" href="#172">172</a>       <strong class="jxr_keyword">final</strong> Element element, <strong class="jxr_keyword">final</strong> String key, <strong class="jxr_keyword">final</strong> String value) {
<a name="173" href="#173">173</a>       assertEquals(<span class="jxr_string">"log4j:properties"</span>, element.getTagName());
<a name="174" href="#174">174</a> 
<a name="175" href="#175">175</a>       <strong class="jxr_keyword">int</strong> childNodeCount = 0;
<a name="176" href="#176">176</a>       <strong class="jxr_keyword">for</strong>(Node child = element.getFirstChild();
<a name="177" href="#177">177</a>                child != <strong class="jxr_keyword">null</strong>;
<a name="178" href="#178">178</a>                child = child.getNextSibling()) {
<a name="179" href="#179">179</a>           <strong class="jxr_keyword">if</strong> (child.getNodeType() == Node.ELEMENT_NODE) {
<a name="180" href="#180">180</a>               assertEquals(<span class="jxr_string">"log4j:data"</span>, child.getNodeName());
<a name="181" href="#181">181</a>               Element childElement = (Element) child;
<a name="182" href="#182">182</a>               assertEquals(key, childElement.getAttribute(<span class="jxr_string">"name"</span>));
<a name="183" href="#183">183</a>               assertEquals(value, childElement.getAttribute(<span class="jxr_string">"value"</span>));
<a name="184" href="#184">184</a>               childNodeCount++;
<a name="185" href="#185">185</a>           }
<a name="186" href="#186">186</a>       }
<a name="187" href="#187">187</a>       assertEquals(1, childNodeCount);  
<a name="188" href="#188">188</a>     }
<a name="189" href="#189">189</a> 
<a name="190" href="#190">190</a>   <em class="jxr_javadoccomment">/**</em>
<a name="191" href="#191">191</a> <em class="jxr_javadoccomment">   * Tests formatted results.</em>
<a name="192" href="#192">192</a> <em class="jxr_javadoccomment">   * @throws Exception if parser can not be constructed or source is not a valid XML document.</em>
<a name="193" href="#193">193</a> <em class="jxr_javadoccomment">   */</em>
<a name="194" href="#194">194</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testFormat() <strong class="jxr_keyword">throws</strong> Exception {
<a name="195" href="#195">195</a>     Logger logger = Logger.getLogger(<span class="jxr_string">"org.apache.log4j.xml.XMLLayoutTest"</span>);
<a name="196" href="#196">196</a>     LoggingEvent event =
<a name="197" href="#197">197</a>       <strong class="jxr_keyword">new</strong> LoggingEvent(
<a name="198" href="#198">198</a>         <span class="jxr_string">"org.apache.log4j.Logger"</span>, logger, Level.INFO, <span class="jxr_string">"Hello, World"</span>, <strong class="jxr_keyword">null</strong>);
<a name="199" href="#199">199</a>     XMLLayout layout = (XMLLayout) createLayout();
<a name="200" href="#200">200</a>     String result = layout.format(event);
<a name="201" href="#201">201</a>     Element parsedResult = parse(result);
<a name="202" href="#202">202</a>     checkEventElement(parsedResult, event);
<a name="203" href="#203">203</a> 
<a name="204" href="#204">204</a>     <strong class="jxr_keyword">int</strong> childElementCount = 0;
<a name="205" href="#205">205</a> 
<a name="206" href="#206">206</a>     <strong class="jxr_keyword">for</strong> (
<a name="207" href="#207">207</a>       Node node = parsedResult.getFirstChild(); node != <strong class="jxr_keyword">null</strong>;
<a name="208" href="#208">208</a>         node = node.getNextSibling()) {
<a name="209" href="#209">209</a>       <strong class="jxr_keyword">switch</strong> (node.getNodeType()) {
<a name="210" href="#210">210</a>       <strong class="jxr_keyword">case</strong> Node.ELEMENT_NODE:
<a name="211" href="#211">211</a>         childElementCount++;
<a name="212" href="#212">212</a>         checkMessageElement((Element) node, <span class="jxr_string">"Hello, World"</span>);
<a name="213" href="#213">213</a> 
<a name="214" href="#214">214</a>         <strong class="jxr_keyword">break</strong>;
<a name="215" href="#215">215</a> 
<a name="216" href="#216">216</a>       <strong class="jxr_keyword">case</strong> Node.COMMENT_NODE:
<a name="217" href="#217">217</a>         <strong class="jxr_keyword">break</strong>;
<a name="218" href="#218">218</a> 
<a name="219" href="#219">219</a>       <strong class="jxr_keyword">case</strong> Node.TEXT_NODE:
<a name="220" href="#220">220</a> 
<a name="221" href="#221">221</a>         <em class="jxr_comment">//  should only be whitespace</em>
<a name="222" href="#222">222</a>         <strong class="jxr_keyword">break</strong>;
<a name="223" href="#223">223</a> 
<a name="224" href="#224">224</a>       <strong class="jxr_keyword">default</strong>:
<a name="225" href="#225">225</a>         fail(<span class="jxr_string">"Unexpected node type"</span>);
<a name="226" href="#226">226</a> 
<a name="227" href="#227">227</a>         <strong class="jxr_keyword">break</strong>;
<a name="228" href="#228">228</a>       }
<a name="229" href="#229">229</a>     }
<a name="230" href="#230">230</a> 
<a name="231" href="#231">231</a>     assertEquals(1, childElementCount);
<a name="232" href="#232">232</a>   }
<a name="233" href="#233">233</a> 
<a name="234" href="#234">234</a>   <em class="jxr_javadoccomment">/**</em>
<a name="235" href="#235">235</a> <em class="jxr_javadoccomment">   * Tests formatted results with an exception.</em>
<a name="236" href="#236">236</a> <em class="jxr_javadoccomment">   * @throws Exception if parser can not be constructed or source is not a valid XML document.</em>
<a name="237" href="#237">237</a> <em class="jxr_javadoccomment">   */</em>
<a name="238" href="#238">238</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testFormatWithException() <strong class="jxr_keyword">throws</strong> Exception {
<a name="239" href="#239">239</a>     Logger logger = Logger.getLogger(<span class="jxr_string">"org.apache.log4j.xml.XMLLayoutTest"</span>);
<a name="240" href="#240">240</a>     Exception ex = <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"'foo' is not a valid name"</span>);
<a name="241" href="#241">241</a>     LoggingEvent event =
<a name="242" href="#242">242</a>       <strong class="jxr_keyword">new</strong> LoggingEvent(
<a name="243" href="#243">243</a>         <span class="jxr_string">"org.apache.log4j.Logger"</span>, logger, Level.INFO, <span class="jxr_string">"Hello, World"</span>, ex);
<a name="244" href="#244">244</a>     XMLLayout layout = (XMLLayout) createLayout();
<a name="245" href="#245">245</a>     String result = layout.format(event);
<a name="246" href="#246">246</a>     Element parsedResult = parse(result);
<a name="247" href="#247">247</a>     checkEventElement(parsedResult, event);
<a name="248" href="#248">248</a> 
<a name="249" href="#249">249</a>     <strong class="jxr_keyword">int</strong> childElementCount = 0;
<a name="250" href="#250">250</a> 
<a name="251" href="#251">251</a>     <strong class="jxr_keyword">for</strong> (
<a name="252" href="#252">252</a>       Node node = parsedResult.getFirstChild(); node != <strong class="jxr_keyword">null</strong>;
<a name="253" href="#253">253</a>         node = node.getNextSibling()) {
<a name="254" href="#254">254</a>       <strong class="jxr_keyword">switch</strong> (node.getNodeType()) {
<a name="255" href="#255">255</a>       <strong class="jxr_keyword">case</strong> Node.ELEMENT_NODE:
<a name="256" href="#256">256</a>         childElementCount++;
<a name="257" href="#257">257</a> 
<a name="258" href="#258">258</a>         <strong class="jxr_keyword">if</strong> (childElementCount == 1) {
<a name="259" href="#259">259</a>           checkMessageElement((Element) node, <span class="jxr_string">"Hello, World"</span>);
<a name="260" href="#260">260</a>         } <strong class="jxr_keyword">else</strong> {
<a name="261" href="#261">261</a>           checkThrowableElement((Element) node, ex);
<a name="262" href="#262">262</a>         }
<a name="263" href="#263">263</a> 
<a name="264" href="#264">264</a>         <strong class="jxr_keyword">break</strong>;
<a name="265" href="#265">265</a> 
<a name="266" href="#266">266</a>       <strong class="jxr_keyword">case</strong> Node.COMMENT_NODE:
<a name="267" href="#267">267</a>         <strong class="jxr_keyword">break</strong>;
<a name="268" href="#268">268</a> 
<a name="269" href="#269">269</a>       <strong class="jxr_keyword">case</strong> Node.TEXT_NODE:
<a name="270" href="#270">270</a> 
<a name="271" href="#271">271</a>         <em class="jxr_comment">//  should only be whitespace</em>
<a name="272" href="#272">272</a>         <strong class="jxr_keyword">break</strong>;
<a name="273" href="#273">273</a> 
<a name="274" href="#274">274</a>       <strong class="jxr_keyword">default</strong>:
<a name="275" href="#275">275</a>         fail(<span class="jxr_string">"Unexpected node type"</span>);
<a name="276" href="#276">276</a> 
<a name="277" href="#277">277</a>         <strong class="jxr_keyword">break</strong>;
<a name="278" href="#278">278</a>       }
<a name="279" href="#279">279</a>     }
<a name="280" href="#280">280</a> 
<a name="281" href="#281">281</a>     assertEquals(2, childElementCount);
<a name="282" href="#282">282</a>   }
<a name="283" href="#283">283</a> 
<a name="284" href="#284">284</a>   <em class="jxr_javadoccomment">/**</em>
<a name="285" href="#285">285</a> <em class="jxr_javadoccomment">   * Tests formatted results with an exception.</em>
<a name="286" href="#286">286</a> <em class="jxr_javadoccomment">   * @throws Exception if parser can not be constructed or source is not a valid XML document.</em>
<a name="287" href="#287">287</a> <em class="jxr_javadoccomment">   */</em>
<a name="288" href="#288">288</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testFormatWithNDC() <strong class="jxr_keyword">throws</strong> Exception {
<a name="289" href="#289">289</a>     Logger logger = Logger.getLogger(<span class="jxr_string">"org.apache.log4j.xml.XMLLayoutTest"</span>);
<a name="290" href="#290">290</a>     NDC.push(<span class="jxr_string">"NDC goes here"</span>);
<a name="291" href="#291">291</a> 
<a name="292" href="#292">292</a>     LoggingEvent event =
<a name="293" href="#293">293</a>       <strong class="jxr_keyword">new</strong> LoggingEvent(
<a name="294" href="#294">294</a>         <span class="jxr_string">"org.apache.log4j.Logger"</span>, logger, Level.INFO, <span class="jxr_string">"Hello, World"</span>, <strong class="jxr_keyword">null</strong>);
<a name="295" href="#295">295</a>     XMLLayout layout = (XMLLayout) createLayout();
<a name="296" href="#296">296</a>     String result = layout.format(event);
<a name="297" href="#297">297</a>     NDC.pop();
<a name="298" href="#298">298</a> 
<a name="299" href="#299">299</a>     Element parsedResult = parse(result);
<a name="300" href="#300">300</a>     checkEventElement(parsedResult, event);
<a name="301" href="#301">301</a> 
<a name="302" href="#302">302</a>     <strong class="jxr_keyword">int</strong> childElementCount = 0;
<a name="303" href="#303">303</a> 
<a name="304" href="#304">304</a>     <strong class="jxr_keyword">for</strong> (
<a name="305" href="#305">305</a>       Node node = parsedResult.getFirstChild(); node != <strong class="jxr_keyword">null</strong>;
<a name="306" href="#306">306</a>         node = node.getNextSibling()) {
<a name="307" href="#307">307</a>       <strong class="jxr_keyword">switch</strong> (node.getNodeType()) {
<a name="308" href="#308">308</a>       <strong class="jxr_keyword">case</strong> Node.ELEMENT_NODE:
<a name="309" href="#309">309</a>         childElementCount++;
<a name="310" href="#310">310</a> 
<a name="311" href="#311">311</a>         <strong class="jxr_keyword">if</strong> (childElementCount == 1) {
<a name="312" href="#312">312</a>           checkMessageElement((Element) node, <span class="jxr_string">"Hello, World"</span>);
<a name="313" href="#313">313</a>         } <strong class="jxr_keyword">else</strong> {
<a name="314" href="#314">314</a>           checkNDCElement((Element) node, <span class="jxr_string">"NDC goes here"</span>);
<a name="315" href="#315">315</a>         }
<a name="316" href="#316">316</a> 
<a name="317" href="#317">317</a>         <strong class="jxr_keyword">break</strong>;
<a name="318" href="#318">318</a> 
<a name="319" href="#319">319</a>       <strong class="jxr_keyword">case</strong> Node.COMMENT_NODE:
<a name="320" href="#320">320</a>         <strong class="jxr_keyword">break</strong>;
<a name="321" href="#321">321</a> 
<a name="322" href="#322">322</a>       <strong class="jxr_keyword">case</strong> Node.TEXT_NODE:
<a name="323" href="#323">323</a> 
<a name="324" href="#324">324</a>         <em class="jxr_comment">//  should only be whitespace</em>
<a name="325" href="#325">325</a>         <strong class="jxr_keyword">break</strong>;
<a name="326" href="#326">326</a> 
<a name="327" href="#327">327</a>       <strong class="jxr_keyword">default</strong>:
<a name="328" href="#328">328</a>         fail(<span class="jxr_string">"Unexpected node type"</span>);
<a name="329" href="#329">329</a> 
<a name="330" href="#330">330</a>         <strong class="jxr_keyword">break</strong>;
<a name="331" href="#331">331</a>       }
<a name="332" href="#332">332</a>     }
<a name="333" href="#333">333</a> 
<a name="334" href="#334">334</a>     assertEquals(2, childElementCount);
<a name="335" href="#335">335</a>   }
<a name="336" href="#336">336</a> 
<a name="337" href="#337">337</a>   <em class="jxr_javadoccomment">/**</em>
<a name="338" href="#338">338</a> <em class="jxr_javadoccomment">   * Tests getLocationInfo and setLocationInfo.</em>
<a name="339" href="#339">339</a> <em class="jxr_javadoccomment">   */</em>
<a name="340" href="#340">340</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testGetSetLocationInfo() {
<a name="341" href="#341">341</a>     XMLLayout layout = <strong class="jxr_keyword">new</strong> XMLLayout();
<a name="342" href="#342">342</a>     assertEquals(false, layout.getLocationInfo());
<a name="343" href="#343">343</a>     layout.setLocationInfo(<strong class="jxr_keyword">true</strong>);
<a name="344" href="#344">344</a>     assertEquals(<strong class="jxr_keyword">true</strong>, layout.getLocationInfo());
<a name="345" href="#345">345</a>     layout.setLocationInfo(false);
<a name="346" href="#346">346</a>     assertEquals(false, layout.getLocationInfo());
<a name="347" href="#347">347</a>   }
<a name="348" href="#348">348</a> 
<a name="349" href="#349">349</a>   <em class="jxr_javadoccomment">/**</em>
<a name="350" href="#350">350</a> <em class="jxr_javadoccomment">   * Tests activateOptions().</em>
<a name="351" href="#351">351</a> <em class="jxr_javadoccomment">   */</em>
<a name="352" href="#352">352</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testActivateOptions() {
<a name="353" href="#353">353</a>     XMLLayout layout = <strong class="jxr_keyword">new</strong> XMLLayout();
<a name="354" href="#354">354</a>     layout.activateOptions();
<a name="355" href="#355">355</a>   }
<a name="356" href="#356">356</a> 
<a name="357" href="#357">357</a>     <em class="jxr_javadoccomment">/**</em>
<a name="358" href="#358">358</a> <em class="jxr_javadoccomment">     * Level with arbitrary toString value.</em>
<a name="359" href="#359">359</a> <em class="jxr_javadoccomment">     */</em>
<a name="360" href="#360">360</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/log4j/HTMLLayoutTest.html">ProblemLevel</a> <strong class="jxr_keyword">extends</strong> Level {
<a name="361" href="#361">361</a>         <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 1L;
<a name="362" href="#362">362</a>         <em class="jxr_javadoccomment">/**</em>
<a name="363" href="#363">363</a> <em class="jxr_javadoccomment">         * Construct new instance.</em>
<a name="364" href="#364">364</a> <em class="jxr_javadoccomment">         * @param levelName level name, may not be null.</em>
<a name="365" href="#365">365</a> <em class="jxr_javadoccomment">         */</em>
<a name="366" href="#366">366</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/log4j/HTMLLayoutTest.html">ProblemLevel</a>(<strong class="jxr_keyword">final</strong> String levelName) {
<a name="367" href="#367">367</a>             <strong class="jxr_keyword">super</strong>(6000, levelName, 6);
<a name="368" href="#368">368</a>         }
<a name="369" href="#369">369</a>     }
<a name="370" href="#370">370</a> 
<a name="371" href="#371">371</a>     <em class="jxr_javadoccomment">/**</em>
<a name="372" href="#372">372</a> <em class="jxr_javadoccomment">     * Tests problematic characters in multiple fields.</em>
<a name="373" href="#373">373</a> <em class="jxr_javadoccomment">     * @throws Exception if parser can not be constructed or source is not a valid XML document.</em>
<a name="374" href="#374">374</a> <em class="jxr_javadoccomment">     */</em>
<a name="375" href="#375">375</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testProblemCharacters() <strong class="jxr_keyword">throws</strong> Exception {
<a name="376" href="#376">376</a>       String problemName = <span class="jxr_string">"com.example.bar&lt;&gt;&amp;\&quot;'"</span>;
<a name="377" href="#377">377</a>       Logger logger = Logger.getLogger(problemName);
<a name="378" href="#378">378</a>       Level level = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/log4j/HTMLLayoutTest.html">ProblemLevel</a>(problemName);
<a name="379" href="#379">379</a>       Exception ex = <strong class="jxr_keyword">new</strong> IllegalArgumentException(problemName);
<a name="380" href="#380">380</a>       String threadName = Thread.currentThread().getName();
<a name="381" href="#381">381</a>       Thread.currentThread().setName(problemName);
<a name="382" href="#382">382</a>       NDC.push(problemName);
<a name="383" href="#383">383</a>       Hashtable mdcMap = MDC.getContext();
<a name="384" href="#384">384</a>       <strong class="jxr_keyword">if</strong> (mdcMap != <strong class="jxr_keyword">null</strong>) {
<a name="385" href="#385">385</a>           mdcMap.clear();
<a name="386" href="#386">386</a>       }
<a name="387" href="#387">387</a>       MDC.put(problemName, problemName);
<a name="388" href="#388">388</a>       LoggingEvent event =
<a name="389" href="#389">389</a>         <strong class="jxr_keyword">new</strong> LoggingEvent(
<a name="390" href="#390">390</a>           problemName, logger, level, problemName, ex);
<a name="391" href="#391">391</a>       XMLLayout layout = (XMLLayout) createLayout();
<a name="392" href="#392">392</a>       layout.setProperties(<strong class="jxr_keyword">true</strong>);
<a name="393" href="#393">393</a>       String result = layout.format(event);
<a name="394" href="#394">394</a>       mdcMap = MDC.getContext();
<a name="395" href="#395">395</a>       <strong class="jxr_keyword">if</strong> (mdcMap != <strong class="jxr_keyword">null</strong>) {
<a name="396" href="#396">396</a>           mdcMap.clear();
<a name="397" href="#397">397</a>       }
<a name="398" href="#398">398</a>       Thread.currentThread().setName(threadName);
<a name="399" href="#399">399</a> 
<a name="400" href="#400">400</a>       Element parsedResult = parse(result);
<a name="401" href="#401">401</a>       checkEventElement(parsedResult, event);
<a name="402" href="#402">402</a> 
<a name="403" href="#403">403</a>       <strong class="jxr_keyword">int</strong> childElementCount = 0;
<a name="404" href="#404">404</a> 
<a name="405" href="#405">405</a>       <strong class="jxr_keyword">for</strong> (
<a name="406" href="#406">406</a>         Node node = parsedResult.getFirstChild(); node != <strong class="jxr_keyword">null</strong>;
<a name="407" href="#407">407</a>           node = node.getNextSibling()) {
<a name="408" href="#408">408</a>         <strong class="jxr_keyword">switch</strong> (node.getNodeType()) {
<a name="409" href="#409">409</a>         <strong class="jxr_keyword">case</strong> Node.ELEMENT_NODE:
<a name="410" href="#410">410</a>           childElementCount++;
<a name="411" href="#411">411</a>           <strong class="jxr_keyword">switch</strong>(childElementCount) {
<a name="412" href="#412">412</a>               <strong class="jxr_keyword">case</strong> 1:
<a name="413" href="#413">413</a>               checkMessageElement((Element) node, problemName);
<a name="414" href="#414">414</a>               <strong class="jxr_keyword">break</strong>;
<a name="415" href="#415">415</a> 
<a name="416" href="#416">416</a>               <strong class="jxr_keyword">case</strong> 2:
<a name="417" href="#417">417</a>               checkNDCElement((Element) node, problemName);
<a name="418" href="#418">418</a>               <strong class="jxr_keyword">break</strong>;
<a name="419" href="#419">419</a> 
<a name="420" href="#420">420</a>               <strong class="jxr_keyword">case</strong> 3:
<a name="421" href="#421">421</a>               checkThrowableElement((Element) node, ex);
<a name="422" href="#422">422</a>               <strong class="jxr_keyword">break</strong>;
<a name="423" href="#423">423</a> 
<a name="424" href="#424">424</a>               <strong class="jxr_keyword">case</strong> 4:
<a name="425" href="#425">425</a>               checkPropertiesElement((Element) node, problemName, problemName);
<a name="426" href="#426">426</a>               <strong class="jxr_keyword">break</strong>;
<a name="427" href="#427">427</a> 
<a name="428" href="#428">428</a>               <strong class="jxr_keyword">default</strong>:
<a name="429" href="#429">429</a>               fail(<span class="jxr_string">"Unexpected element"</span>);
<a name="430" href="#430">430</a>               <strong class="jxr_keyword">break</strong>;
<a name="431" href="#431">431</a>           }
<a name="432" href="#432">432</a> 
<a name="433" href="#433">433</a>           <strong class="jxr_keyword">break</strong>;
<a name="434" href="#434">434</a> 
<a name="435" href="#435">435</a>         <strong class="jxr_keyword">case</strong> Node.COMMENT_NODE:
<a name="436" href="#436">436</a>           <strong class="jxr_keyword">break</strong>;
<a name="437" href="#437">437</a> 
<a name="438" href="#438">438</a>         <strong class="jxr_keyword">case</strong> Node.TEXT_NODE:
<a name="439" href="#439">439</a> 
<a name="440" href="#440">440</a>           <em class="jxr_comment">//  should only be whitespace</em>
<a name="441" href="#441">441</a>           <strong class="jxr_keyword">break</strong>;
<a name="442" href="#442">442</a> 
<a name="443" href="#443">443</a>         <strong class="jxr_keyword">default</strong>:
<a name="444" href="#444">444</a>           fail(<span class="jxr_string">"Unexpected node type"</span>);
<a name="445" href="#445">445</a> 
<a name="446" href="#446">446</a>           <strong class="jxr_keyword">break</strong>;
<a name="447" href="#447">447</a>         }
<a name="448" href="#448">448</a>       }
<a name="449" href="#449">449</a>     }
<a name="450" href="#450">450</a> 
<a name="451" href="#451">451</a>     <em class="jxr_javadoccomment">/**</em>
<a name="452" href="#452">452</a> <em class="jxr_javadoccomment">      * Tests CDATA element within NDC content.  See bug 37560.</em>
<a name="453" href="#453">453</a> <em class="jxr_javadoccomment">      */</em>
<a name="454" href="#454">454</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testNDCWithCDATA() <strong class="jxr_keyword">throws</strong> Exception {
<a name="455" href="#455">455</a>         Logger logger = Logger.getLogger(<span class="jxr_string">"com.example.bar"</span>);
<a name="456" href="#456">456</a>         Level level = Level.INFO;
<a name="457" href="#457">457</a>         String ndcMessage =<span class="jxr_string">"&lt;envelope&gt;&lt;faultstring&gt;&lt;![CDATA[The EffectiveDate]]&gt;&lt;/faultstring&gt;&lt;envelope&gt;"</span>;
<a name="458" href="#458">458</a>         NDC.push(ndcMessage);
<a name="459" href="#459">459</a>         LoggingEvent event =
<a name="460" href="#460">460</a>           <strong class="jxr_keyword">new</strong> LoggingEvent(
<a name="461" href="#461">461</a>             <span class="jxr_string">"com.example.bar"</span>, logger, level, <span class="jxr_string">"Hello, World"</span>, <strong class="jxr_keyword">null</strong>);
<a name="462" href="#462">462</a>         Layout layout = createLayout();
<a name="463" href="#463">463</a>         String result = layout.format(event);
<a name="464" href="#464">464</a>         NDC.clear();
<a name="465" href="#465">465</a>         Element parsedResult = parse(result);
<a name="466" href="#466">466</a>         NodeList ndcs = parsedResult.getElementsByTagName(<span class="jxr_string">"log4j:NDC"</span>);
<a name="467" href="#467">467</a>         assertEquals(1, ndcs.getLength());
<a name="468" href="#468">468</a>         StringBuffer buf = <strong class="jxr_keyword">new</strong> StringBuffer();
<a name="469" href="#469">469</a>         <strong class="jxr_keyword">for</strong>(Node child = ndcs.item(0).getFirstChild();
<a name="470" href="#470">470</a>                 child != <strong class="jxr_keyword">null</strong>;
<a name="471" href="#471">471</a>                 child = child.getNextSibling()) {
<a name="472" href="#472">472</a>             buf.append(child.getNodeValue());
<a name="473" href="#473">473</a>         }
<a name="474" href="#474">474</a>         assertEquals(ndcMessage, buf.toString());
<a name="475" href="#475">475</a>    }
<a name="476" href="#476">476</a> 
<a name="477" href="#477">477</a>     <em class="jxr_javadoccomment">/**</em>
<a name="478" href="#478">478</a> <em class="jxr_javadoccomment">      * Tests CDATA element within exception.  See bug 37560.</em>
<a name="479" href="#479">479</a> <em class="jxr_javadoccomment">      */</em>
<a name="480" href="#480">480</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testExceptionWithCDATA() <strong class="jxr_keyword">throws</strong> Exception {
<a name="481" href="#481">481</a>         Logger logger = Logger.getLogger(<span class="jxr_string">"com.example.bar"</span>);
<a name="482" href="#482">482</a>         Level level = Level.INFO;
<a name="483" href="#483">483</a>         String exceptionMessage =<span class="jxr_string">"&lt;envelope&gt;&lt;faultstring&gt;&lt;![CDATA[The EffectiveDate]]&gt;&lt;/faultstring&gt;&lt;envelope&gt;"</span>;
<a name="484" href="#484">484</a>         LoggingEvent event =
<a name="485" href="#485">485</a>           <strong class="jxr_keyword">new</strong> LoggingEvent(
<a name="486" href="#486">486</a>             <span class="jxr_string">"com.example.bar"</span>, logger, level, <span class="jxr_string">"Hello, World"</span>, <strong class="jxr_keyword">new</strong> Exception(exceptionMessage));
<a name="487" href="#487">487</a>         Layout layout = createLayout();
<a name="488" href="#488">488</a>         String result = layout.format(event);
<a name="489" href="#489">489</a>         Element parsedResult = parse(result);
<a name="490" href="#490">490</a>         NodeList throwables = parsedResult.getElementsByTagName(<span class="jxr_string">"log4j:throwable"</span>);
<a name="491" href="#491">491</a>         assertEquals(1, throwables.getLength());
<a name="492" href="#492">492</a>         StringBuffer buf = <strong class="jxr_keyword">new</strong> StringBuffer();
<a name="493" href="#493">493</a>         <strong class="jxr_keyword">for</strong>(Node child = throwables.item(0).getFirstChild();
<a name="494" href="#494">494</a>                 child != <strong class="jxr_keyword">null</strong>;
<a name="495" href="#495">495</a>                 child = child.getNextSibling()) {
<a name="496" href="#496">496</a>             buf.append(child.getNodeValue());
<a name="497" href="#497">497</a>         }
<a name="498" href="#498">498</a>         assertTrue(buf.toString().indexOf(exceptionMessage) != -1);
<a name="499" href="#499">499</a>    }
<a name="500" href="#500">500</a> 
<a name="501" href="#501">501</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

